Buscar autorizações

Obter autorização específica

Use este endpoint para obter informações sobre uma autorização Pix Automática

Request

GET 'https://apisandbox.delbank.com.br/baas/api/v1/automatic-pix/authorizations/:identifier'

Headers

Name	Description
x-delbank-api-key	Required. API key

Path Parameters:

Name	Type	Description
identifier	string	Required. Authorization identifier

Resposta

O código de status 200 indica sucesso na consulta.

Se a consulta for bem-sucedida, o retorno terá os seguintes campos em formato JSON:

{
    "idRecorrencia": "RR999999182025050751897433907",
    "idReqJdPi": "01000000-8965-4694-aa3d-08dd8d6a7e91",
    "dtHrReqJdPi": "2025-05-07T13:24:28.600Z",
    "dtHrSituacao": "2025-05-13T17:23:49.343Z",
    "stJdPiProc": 0,
    "stJdPi": 0,
    "idSolicitacaoRecorrencia": "SC3822485720250507Q5fbI7GDMi9",
    "jornada": 3,
    "tpFrequencia": 1,
    "dtInicialRecorrencia": "2025-06-01",
    "dtFinalRecorrencia": "2025-12-30",
    "valor": 100.50,
    "recebedor": {
        "ispb": 21018182,
        "cnpj": 76961727000105,
        "nome": "Demo Pix Automatico"
    },
    "pagador": {
        "ispb": 38224857,
        "tpPessoa": 0,
        "cpfCnpj": 5876932582,
        "nome": "Alisson Oliveira Neves ",
        "nrAgencia": "1",
        "tpConta": 0,
        "nrConta": "42790",
        "codMunIbge": 2800308
    },
    "devedor": {
        "tpPessoa": 0,
        "cpfCnpj": 73463515172,
        "nome": "Renan Cesar Nunes"
    },
    "nrContrato": "1234556",
    "descContrato": "1234556",
    "dtHrCriacaoRecorrencia": "2025-05-07T10:30:00.000Z",
    "dtHrAtualizacaoRecorrencia": "2025-05-07T13:24:28.848Z",
    "dtHrAutorizacaoRecorrencia": "2025-05-07T10:45:00.000Z"
}

Buscar todas as autorizações

Este endpoint buscará todas as autorizações, sejam elas enviadas ou recebidas.

Request

GET 'https://apisandbox.delbank.com.br/baas/api/v1/automatic-pix/authorizations'

Headers

Name	Description
x-delbank-api-key	Required. API key

Path Parameters:

Name	Type	Description
flow	enum	Which journey to search for, values: 1, 2, 3, 4
startDate	date	The start date of the query
endDate	date	The end date of the query
page	number	The page number. Use this to paginate results depending on pageSize
pageSize	number	The amount of results returned per page
payerDocument	string	CPF or CNPJ
payerType	enum	0 for CPF or 1 for CNPJ

Resposta

O código de status 200 indica sucesso na consulta.

Se a consulta for bem-sucedida, o retorno terá os seguintes campos em formato JSON:

{
	"authorizations": [
		{
			"id":"RR0435879820240605njua7shf40o",
			"idempotencyKey":"70F945C1-9024-4123-1001-A1DE2A0000D1",
			"authorizationResult":true,
			"journey":1,
			"frequencyType":4,
			"startDate":"2024-01-10",
			"endDate":"2026-01-10",
			"amount":550,
			"beneficiary": {
				"ispb":4358798,
				"document":61695227000193,
				"name":"Enel"
			},
			"payer": {
				"ispb":99999004,
				"type":0,
				"document":11111111111,
				"branch":"1234",
				"number":"12345678",
			},
			"debtor": {
				"type":0,
				"document":4623217035,
				"name":"Ciclano da Silva"
			},
			"contractNumber":"1234567890ABC",
			"description":"Conta de energia",
		}
		{
			"id":"RR0435879820240605njua7shf40o",
			"idempotencyKey":"70F945C1-9024-4123-1001-A1DE2A0000D1",
			"authorizationResult":true,
			"journey":1,
			"frequencyType":4,
			"startDate":"2024-01-10",
			"endDate":"2026-01-10",
			"amount":550,
			"beneficiary": {
				"ispb":4358798,
				"document":61695227000193,
				"name":"Enel"
			},
			"payer": {
				"ispb":99999004,
				"type":0,
				"document":11111111111,
				"branch":"1234",
				"number":"12345678",
			},
			"debtor": {
				"type":0,
				"document":4623217035,
				"name":"Ciclano da Silva"
			},
			"contractNumber":"1234567890ABC",
			"description":"Conta de energia",
			"cancellingData": [
				{
					"cancelId":"IC0435879820240627acbd4fhn26b",
					"debtorType":0,
					"debtorDocument":11111111111,
					"cancelReason":7,
					"cancelDate":"2024-06-07T11:24:48.047Z",
					"cancelStatus":0
				}
				{
					"cancelId":"IC0435879820240627acbd4fhn26b",
					"debtorType":0,
					"debtorDocument":11111111111,
					"cancelReason":7,
					"cancelDate":"2024-06-07T11:24:48.047Z",
					"cancelStatus":0
				}
			]
		}
	]
}